home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / MSDOS / (m)aal / PKARC.DOC < prev    next >
Text File  |  1986-12-14  |  21KB  |  606 lines
  1. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 1
  2.  
  3.  
  4.  
  5.  
  6.                         Table of Contents
  7.                         -----------------
  8.  
  9.  
  10.  Topic                                                 Page
  11.  -----                                                 ----
  12.  
  13.    Features and Overview .............................. 2
  14.  
  15.    Archive Functions
  16.        Add files to an archive ........................ 4
  17.        Update files to an archive ..................... 4
  18.        Freshen files in an archive .................... 4
  19.        Move files to an archive ....................... 5
  20.        Delete files in an archive ..................... 5
  21.        Verbose listing of files in an archive ......... 5
  22.  
  23.    PKARC Archive Commenting Feature ................... 6
  24.  
  25.    Using a Ramdisk with PKARC ......................... 8
  26.  
  27.    Using PKARC in a batch file ........................ 8
  28.  
  29.    PKARC Error Messages ............................... 9
  30.   
  31.    PKARC Revision history ............................. 11
  32.  
  33.    General Information ................................ 12
  34.  
  35.    Software License ................................... 13
  36.  
  37. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 2
  38.  
  39.  
  40.  
  41. Features
  42. --------
  43.  
  44.   - THE FASTEST CREATION AND UPDATING OF ARCHIVES - EVER.
  45.  
  46.   - Highest compression ratios with state-of-the-art Enhanced
  47.     Dynamic Ziv-Lempel-Welch Crunching and Squashing.
  48.  
  49.   - Unique Archive Commenting capability.
  50.  
  51.   - Data integrity ensured by 16 bit Cyclic Redundancy Check.
  52.  
  53.   - Superior file buffering.
  54.  
  55.   - Not copy protected.
  56.  
  57.   - Pay only if you find the software useful.
  58.  
  59.  
  60. Overview
  61. --------
  62.  
  63. An archive is a collection of one or more files  collected  into  a 
  64. single  archive  file.  A file extension of .ARC is usually used to 
  65. denote an archive.  Each file in an archive is compressed  to  save 
  66. disk  space,  backup storage space, and file transfer time.  When a 
  67. file is archived, it is  analyzed  and  compressed  with  the  most 
  68. optimal  data  compression  method for that file.  Every file in an 
  69. archive is stored with a 16-bit Cyclic Redundancy  Check  (CRC)  to 
  70. ensure data integrity when the file is extracted from the archive.
  71.  
  72. PKARC is a FAST!   archive  update/create  utility  that  generates 
  73. archives.   It  is  compatible with SEAware's (Software Enhancement 
  74. Associate's) ARC program  and  my  own  FAST!   archive  extraction 
  75. utility PKXARC, but is many times faster than SEAware's ARC program 
  76. and faster than ANY OTHER  archive  utility.   PKARC  achieves  its 
  77. speed  through  the  use of highly optimized assembly language code 
  78. and advanced file buffering techniques.  With version 1.1 of PKARC, 
  79. an  Enhanced Ziv-Lempel-Welch crunching technique is employed which 
  80. can result in an up to a 40% space savings over ARC.  With  version 
  81. 2.0  of  PKARC, a new compression method called "squashing" is used 
  82. which can save up to an additional 10% or more for large text files.
  83.  
  84.  
  85. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 3
  86.  
  87.  
  88.  
  89. Using PKARC
  90. -----------
  91.  
  92. Usage: PKARC [compatibility options] options archive [filespec...]
  93.  
  94. Compatibility options are:
  95.  
  96.       /oc  = old crunching (no squashing)
  97.       /ot  = old datestamping method
  98.       /otc = both old crunching and datestamping
  99.  
  100. Options are:
  101.  
  102.       a = add files to archive       d = delete files from archive
  103.       f = freshen files in archive   m = move files to archive
  104.       u = update files in archive    v = display verbose listing of archive
  105.       l = display software license   c = add/update file comments
  106.       x = add/update archive comment
  107.  
  108. The  /oc  compatibility  option  prevents  PKARC  from  using  file 
  109. squashing.  With squashing disabled,  PKARC  will  create  archives 
  110. completely compatible with SEAware's ARC program and older versions 
  111. of PKXARC.
  112.  
  113. The /ot compatibility  option  forces  PKARC  to  follow  SEAware's 
  114. archive  datestamping  method.  By default, PKARC sets the time and 
  115. date of an archive to the current time  and  date  whenever  it  is 
  116. modified.   The  SEA  archiver  will  set  the  time and date of an 
  117. archive to the time and date of the latest file within the archive.  
  118. Using  this  option  will  cause  PKARC  to use this archive dating 
  119. method.
  120.  
  121. The  two compatibility options can be specified at the same time by 
  122. using either /oct or /otc.
  123.  
  124. The  A,F,M,  and U options can be followed by a C and/or X to cause 
  125. prompting for the file comments and/or the archive comment.  The  V 
  126. option  can  be followed by a C for a verbose listing with the file 
  127. comments.
  128.  
  129. The DOS wildcards * and ? can be used when specifying file names.
  130.  
  131.  
  132. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 4
  133.  
  134.  
  135.  
  136. Adding files to an archive
  137. --------------------------
  138.  
  139. This  option is used to add files to an existing archive, or create 
  140. a new archive with the specified files.  This is  the  most  common 
  141. use  of  PKARC.  If no list of files is given, all the files in the 
  142. current directory will be added.  Examples:
  143.  
  144. PKARC a stuff
  145.  
  146. will collect all the files in the current directory, and place them 
  147. in the archive STUFF.ARC
  148.  
  149. PKARC a a:manuals b:*.doc b:*.txt
  150.  
  151. will collect all files with an extension of .DOC or .TXT on drive B 
  152. and place them in the archive A:MANUALS.ARC.
  153.  
  154.  
  155. Updating files to an archive
  156. ----------------------------
  157.  
  158. This option works the same as the Add option,  with  the  exception 
  159. that if a file already exists within an archive, it will be updated 
  160. only if the datestamp of the file on the disk is  dated  after  the 
  161. file  within  the  archive.   This option can be used to prevent an 
  162. earlier version of a file from overwriting a later version which is 
  163. in an archive.  For example:
  164.  
  165. PKARC u manuals *.doc *.txt
  166.  
  167. will  collect all files with an extension of .DOC or .TXT and place 
  168. them in the archive MANUALS.ARC.  If however, a file already exists 
  169. in  the  archive  and  on  the  disk  (say  STARTREK.DOC), the file 
  170. STARTREK.DOC will be added to the archive only if it is dated later 
  171. than  the  version already in the archive.  If the file on the disk 
  172. has an earlier date, then the version in the archive will remain.
  173.  
  174.  
  175. Freshening files in an archive
  176. ------------------------------
  177.  
  178. This option is used to ensure that  an  archive  contains  all  the 
  179. latest  versions of its files.  The Freshen function works like the 
  180. Update function, except it will not cause new files to be added  to 
  181. the archive.  For example:
  182.  
  183. PKARC f arcutil b:*.*
  184.  
  185. will  go  through  all the files on drive B and look for files that 
  186. are in already in the archive, but with a later date.  If  a  later 
  187. version is found, it will be updated in the archive.
  188.  
  189.  
  190. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 5
  191.  
  192.  
  193.  
  194. Moving files to an archive
  195. --------------------------
  196.  
  197. This option works exactly like the Add function,  except  that  the 
  198. original   files   are  deleted  from  the  disk  after  successful 
  199. archiving.  The files are deleted only after the archive is created 
  200. and  completed,  and  no errors have occurred.  If any errors occur 
  201. during the archiving process (such as disk full) the original files 
  202. will not be deleted.  For example:
  203.  
  204. PKARC m cfiles *.c
  205.  
  206. will add all files with an extension .C to the archive  CFILES.ARC.  
  207. After  all  the  files have been successfully added to the archive, 
  208. they will be deleted from the disk.
  209.  
  210. Deleting files from an archive
  211. ------------------------------
  212.  
  213. This option is used to delete files from within an archive.  For 
  214. example:
  215.  
  216. PKARC d games *.bas
  217.  
  218. This will delete all files with the extension .BAS from the archive 
  219. GAMES.ARC.
  220.  
  221.  
  222. Verbose listing of an archive
  223. -----------------------------
  224.  
  225. This option is used to list the contents of an archive.  The 
  226. listing is in the following format:
  227.  
  228. Filename        Length   Method     Size   Ratio    Date      Time
  229. --------        ------   ------    ------  -----    ----      ----
  230. FILENAME.EXT    nnnnnn  aaaaaaaa   nnnnnn   nn%   mm-dd-yy  hr:mm:ss
  231.  
  232. The length is the true length of the file.  The method is the  data 
  233. compression technique used on the file and is one of the following:
  234.  
  235. Stored    The file was Stored.
  236. Packed    The file was Packed with non-repeat packing.
  237. Squeezed  The file was Squeezed with Huffman encoding.
  238. crunched  The file was crunched with old style Ziv-Lempel-Welch compression.
  239. Crunched  The file was Crunched with Dynamic Ziv-Lempel-Welch compression.
  240. Squashed  The file was Squashed with Dynamic Ziv-Lempel-Welch compression.
  241.  
  242. The  size  is the resulting size of the file after compression, and 
  243. the ratio is the percentage of file space saved.   For  example,  a 
  244. file  with  a  length  of  10,000  and a size of 2,500 would have a 
  245. savings ratio of 75%.
  246.  
  247.  
  248. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 6
  249.  
  250.  
  251.  
  252. PKARC Archive File Comments Feature
  253. -----------------------------------
  254.  
  255. One  of  the  unique  features  of  PKARC is the ability to store a 
  256. comment with an archive, and optionally a comment for each file  in 
  257. an archive, similar to the file descriptions found on many Bulletin 
  258. Board Systems.  The archive comment is automatically displayed when 
  259. the archive is manipulated by PKARC version 1.2 or later and PKXARC 
  260. version 3.3 or later.  Each file in  an  archive  can  be  given  a 
  261. comment  which  can be displayed with the verbose listing function.  
  262.  
  263. Following the V option with letter C will cause the comments to  be 
  264. displayed.  For example:
  265.  
  266. PKARC vc utility
  267.  
  268. will display the files in the archive UTILITY.ARC with the archive 
  269. file comments in the following format:
  270.  
  271. Filename        Comment                             Date      Time
  272. --------        --------------------------------    ----      ----
  273. FILENAME.EXT    cccccccccccccccccccccccccccccccc  mm-dd-yy  hr-mm-ss
  274.  
  275. The archive comment and file comments can be up to 32 characters in 
  276. length.
  277.  
  278. If the A,U,F, or M options are followed  by  a  X,  prompting  will 
  279. occur for the archive comment.  For example:
  280.  
  281. PKARC ax datafils *.dat
  282.  
  283. will   add  all  files  with  an  extension  .DAT  to  the  archive 
  284. DATAFILS.ARC and prompt for the archive comment for DATAFILS.ARC.
  285.  
  286. If  the  A,U,F,  or  M  options are followed by a C, prompting will 
  287. occur for a file comment after each file is added to  the  archive.  
  288. For example:
  289.  
  290. PKARC ac datafils *.dat
  291.  
  292. will   add  all  files  with  an  extension  .DAT  to  the  archive 
  293. DATAFILS.ARC.  After each file is  placed  into  the  archive,  the 
  294. comment for that file can be entered.
  295.  
  296. The  C  and  X options from above can be combined to prompt for the 
  297. archive comment and the  file  comments  at  the  same  time.   For 
  298. example:
  299.  
  300. PKARC acx datafils *.dat
  301.  
  302. will  add  all  files  with  an  extension  .DAT  to  the   archive 
  303. DATAFILS.ARC  and  cause  prompting for the archive comment and the 
  304. file comments.
  305.  
  306. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 7
  307.  
  308.  
  309.  
  310. The  C  option  can  be  used  to add or update file comments.  For 
  311. example:
  312.  
  313. PKARC c programs
  314.  
  315. will go through all files in the archive  PROGRAMS.ARC  and  prompt 
  316. for  a comment for each file.  Comments can be updated selectively, 
  317. such as:
  318.  
  319. PKARC c programs spoolkey.sys
  320.  
  321. will allow the file comment for the specified file to be  added  or 
  322. changed.
  323.  
  324. The X option can be used to add or update the archive comment.  For 
  325. example:
  326.  
  327. PKARC x programs
  328.  
  329. will add or update the archive comment for the archive PROGRAMS.ARC.
  330.  
  331. The  C  and  X options from above can be combined to prompt for the 
  332. archive comment and the  file  comments  at  the  same  time.   For 
  333. example:
  334.  
  335. PKARC cx programs
  336.  
  337. will add or update the archive comment and the  file  comments  for 
  338. the archive PROGRAMS.ARC.
  339.  
  340. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 8
  341.  
  342.  
  343.  
  344. NOTE: The  comments  are  stored  in  a  way totally transparent to 
  345.       SEAware's ARC program and and have no effect on the operation 
  346.       of ARC.
  347.  
  348.       However,  because  SEAware's  ARC program does not know about 
  349.       archive comments or file comments, ARC truncates the comments 
  350.       from  an  archive  when  modifying  it.   Using SEAware's ARC 
  351.       program to add, update, move, freshen or delete files from an 
  352.       archive  will  cause all comments to be lost.  If you wish to 
  353.       retain the comments within an archive, it is recommended that 
  354.       the use of SEAware's ARC program be avoided.
  355.  
  356.  
  357. Using a Ramdisk with PKARC
  358. --------------------------
  359.  
  360. PKARC sometimes creates one or two temporary files while  archiving 
  361. files.  The default drive for these files is the current drive.  In 
  362. order to increase performance, PKARC can be told which drive and/or 
  363. subdirectory  to  use  for  temporary files through DOS environment 
  364. strings.   PKARC  searches   the   environment   for   the   string 
  365. PKARCTMP=pathspec.    For   compatibility   with  ARC,  the  string 
  366. ARCTEMP=pathspec can be used as well.  For example if drive D is  a 
  367. ramdisk, entering:
  368.  
  369. SET PKARCTMP=D:
  370.  
  371. at the DOS prompt will cause PKARC to use  drive  D  for  temporary 
  372. files.
  373.  
  374.  
  375. Using PKARC in a batch file
  376. ---------------------------
  377.  
  378. If you are using PKARC from a batch file, you  can  test  if  PKARC 
  379. aborted  with  an  error  using the DOS errorlevel variable.  PKARC 
  380. returns a non-zero errorlevel if an  error  occurred,  and  a  zero 
  381. errorlevel for normal termination.  
  382.  
  383. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 9
  384.  
  385.  
  386.  
  387. PKARC Error Messages
  388. --------------------
  389.  
  390. When  any  of the following errors are detected, PKARC will display 
  391. the indicated message and abort to DOS.   All  original  files  and 
  392. archives  will  be  intact,  as  PKARC does not overwrite or delete 
  393. existing files on the disk until the entire archive processing  has 
  394. been  successfully  completed.
  395.  
  396.  
  397. PKARC: Unknown option: (unknown character)
  398.  
  399.     The displayed option is unknown.
  400.  
  401. PKARC: Insufficient Memory
  402.  
  403.     There is not enough free memory to run PKARC.
  404.  
  405. PKARC: No archive specified.
  406.  
  407.     The name of the archive to be processed must be given.
  408.  
  409. PKARC: No files specified for deletion.
  410.  
  411.     The delete option was  specified,  but  no  files  were  given. 
  412.     Unlike other options, delete does not assume *.* if no specific 
  413.     files are given.
  414.  
  415. PKARC: Can't find XXXXXXXX.YYY
  416.  
  417.     The specified file(s) could not be found.
  418.  
  419. PKARC: No file(s) found.
  420.  
  421.     No files were found to add or update to the archive.
  422.  
  423. PKARC: Can't create file XXXXXXXX.YYY
  424.  
  425.     The displayed file could not be created.  The output directory 
  426.     is probably invalid or full.
  427.  
  428. PKARC: Too many files.
  429.  
  430.     This error will occur if more than 512 files  or  16  different 
  431.     drive/pathspecs  are  given  at  one  time for the add, update, 
  432.     freshen, or move options.  While there is no limit on the total 
  433.     number of files allowed in an archive, only 512 can be added at 
  434.     one time.
  435.     
  436.  
  437. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 10
  438.  
  439.  
  440.  
  441. PKARC: XXXXXXXX.YYY is not an archive.
  442.  
  443.     The archive name given to PKARC existed on the disk, but either 
  444.     is not an archive, or is corrupted.
  445.  
  446. PKARC: Can't open XXXXXXXX.YYY
  447.  
  448.     The displayed file could not be opened.
  449.  
  450. PKARC: disk full
  451.  
  452.     The disk is full.
  453.  
  454. PKARC: XXXXXXXX.YYY is read-only!
  455.  
  456.     The displayed archive file is a read-only or system file.
  457.     No modification (add, update, delete, etc.) is possible.
  458.  
  459. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 11
  460.  
  461.  
  462.  
  463. PKARC Revision History
  464. ----------------------
  465.  
  466. *** PKARC version 1.0, 8-06-86 ***
  467.  
  468. Initial release.
  469.  
  470.  
  471. *** PKARC version 1.1, 9-12-86 ***
  472.  
  473. Enhanced  Ziv-Lempel-Welch  compression  was  added  to PKARC.  The 
  474. enchanced crunching algorithm provides superior compression  ratios 
  475. over  the  traditional  crunching  algorithm  used in SEAware's ARC 
  476. program.  Files crunched with the enhanced crunching algorithm  are 
  477. up to 40% smaller, yet still fully compatible with ARC and PKXARC.
  478.  
  479. File buffering has been drastically improved, resulting in faster 
  480. compression, especially on floppy disks.
  481.  
  482. The improved buffering and other optimizations have resulted  in  a 
  483. twofold increase in archiving speed over PKARC version 1.0. 
  484.  
  485.  
  486. *** PKARC version 1.2, 10-23-86 ***
  487.  
  488. PKARC  version  1.1  inadvertently  introduced a rare bug involving 
  489. squeezed files.  This has been corrected in version 1.2.
  490.  
  491. Archive commenting ability has been  added  to  PKARC.   PKARC  now 
  492. allows  a comment to be assigned to an archive, in addition to each 
  493. file within an  archive.   The  archive  comment  is  automatically 
  494. displayed  when  the archive is manipulated by PKARC version 1.2 or 
  495. later and PKXARC version 3.3 or later.
  496.  
  497. File  buffering  has  been improved.  While PKARC will still run in 
  498. minimum of 128K of RAM, PKARC will take advantage of up to 224K  of 
  499. RAM if available to increase file buffering.
  500.  
  501. The  Enhanced  Ziv-Lempel-Welch  compression  has   been   slightly 
  502. improved.   Some  files  will  compress  up to 5% smaller than with 
  503. PKARC  version  1.1.   Binary  files  should  experience  the  most 
  504. improvement.
  505.  
  506. Optimizations  in  PKARC  version 1.2  have resulted in up to a 20% 
  507. increase in archiving speed over PKARC version 1.1.
  508.  
  509.  
  510. *** PKARC version 2.0, 12-15-86 ***
  511.  
  512. A new compression method called  "squashing"  was  added  to  PKARC 
  513. version  2.0.  Squashing is a variation of Dynamic Ziv-Lempel-Welch 
  514. compression  which  can  yield  a  significant   improvement   over 
  515. crunching for larger text files.  Also, the unsquashing of files is 
  516. faster than uncrunching.  In addition, the Dynamic Ziv-Lempel-Welch 
  517. crunching  has  been  improved in PKARC version 2.0 with some files 
  518. crunching significantly smaller than with PKARC version 1.2.
  519.  
  520. As  always,  minor  speed  improvements  have resulted in about 10% 
  521. speed increase over the previous version.
  522.  
  523. An  "old  compatibility  switch" was added to PKARC version 2.0 for 
  524. compatibility with SEAware's archive dating  method.   By  default, 
  525. PKARC  sets the time and date of an archive to the current time and 
  526. date whenever it is modified.  The SEA archiver will set  the  time 
  527. and  date  of  an  archive  to the time and date of the latest file 
  528. within the archive.  While most users prefer that an  archive  date 
  529. be  set  to  the  current date, this switch was added for those who 
  530. prefer the SEA method.
  531.  
  532.  
  533. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 12
  534.  
  535.  
  536.  
  537. General Information
  538. -------------------
  539.  
  540. PKARC will run on any  IBM  PC/XT/AT/RT/jr/Portable/Convertible  or 
  541. DOS  compatible  whatever  running  PC/MS-DOS  2.0 or higher with a 
  542. minimum of 128K free RAM.
  543.  
  544.  
  545. IBM is a registered trademark of the International Business Machine
  546. Corporation.
  547. MS-DOS is a registered trademark of Microsoft Inc.
  548.  
  549.  
  550. If you have any questions or comments about PKARC send them to Phil 
  551. Katz at:
  552.  
  553. Exec-PC multi-user IBM BBS, Bob Mahoney SYSOP
  554. Shorewood, Wisconsin
  555. 414-964-5160
  556. 300/1200/2400 baud, 24 hours a day, 16 lines
  557.  
  558. or
  559.  
  560. RBBS-PC of FARGO, Loren Jones SYSOP
  561. Fargo, North Dakota
  562. 701-293-5973
  563. 300/1200/2400 baud, 24 hours a day
  564.  
  565.  
  566. Special thanks to Bob Mahoney, Alan Losoff, Gene Alm,
  567. Loren Jones, and Mike Shawaluk.
  568.  
  569.  
  570. PKARC  FAST!  Archive Create/Update Utility  Version 2.0  12-15-86  Page 13
  571.  
  572.  
  573.  
  574. License
  575. -------
  576.  
  577. Copyright (c) 1986 PKWARE, Inc.  All Rights Reserved.
  578.  
  579. You are free to use, copy and distribute PKARC providing that:
  580.  
  581.         NO FEE IS CHARGED FOR USE, COPYING OR DISTRIBUTION.
  582.  
  583.         IT IS NOT MODIFIED IN ANY WAY.
  584.  
  585. Clubs  and  user  groups  may charge a nominal fee for expenses and 
  586. handling while distributing PKARC.
  587.  
  588. Volume  discounts,  site  licenses,  commercial licenses and custom 
  589. versions of PKARC and PKXARC are available.  Write to  the  address 
  590. below for more information.
  591.  
  592. This program is provided AS IS without any warranty,  expressed  or 
  593. implied,  including  but  not  limited  to fitness for a particular 
  594. purpose.
  595.  
  596. If you find PKARC fast, easy, and convenient to use, a contribution 
  597. of $20 would be appreciated.  With each contribution of $45 or more 
  598. you  will be registered to receive a diskette with the next version 
  599. of PKARC and PKXARC  when  available.   Please  state  the  current 
  600. versions of PKARC and PKXARC that you have.  Send contributions to:
  601.  
  602. PKWARE, Inc.
  603. 7032 Ardara Avenue
  604. Glendale, WI 53209
  605.  
  606.